<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilplmi: xplmi_ipi.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilplmi
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xplmi__ipi_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xplmi_ipi.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the header file which contains definitions for the ipi manager. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date        Changes
----- ---- -------- -------------------------------------------------------
1.00  ma   10/09/2018 Initial release
1.01  kc   04/09/2019 Added code to register/enable/disable interrupts
      kc   05/21/2019 Updated IPI error code to response buffer
      ma   08/01/2019 Added LPD init code
      rv   02/04/2020 Set the 1st element of response array always to status
      bsv  02/13/2020 XilPlmi generic commands should not be supported
                      via IPI
      ma   02/21/2020 Added code to allow event logging command via IPI
      ma   02/28/2020 Added code to disallow EM commands over IPI
      bsv  03/09/2020 Added code to support CDO features command
      ma   03/19/2020 Added features command for EM module
      bsv  04/04/2020 Code clean up
1.02  bsv  06/02/2020 Added code to support GET BOARD command and disallow
                      SET BOARD command via IPI
      bm   10/14/2020 Code clean up
1.03  ma   03/04/2021 Added IPI secure related defines
      bsv  04/16/2021 Added provision to store Subsystem Id in XilPlmi
1.04  ma   08/09/2021 Added IPI_PMC_IMR register define
1.05  skd  04/21/2022 Misra-C violation Rule 8.7 fixed
      skg  06/20/2022 Misra-C violation Rule 8.13 fixed
      bm   07/06/2022 Refactor versal and versal_net code
      bm   07/18/2022 Shutdown modules gracefully during update
1.08  bm   06/23/2023 Added IPI access permissions validation
1.09  bm   02/23/2024 Ack In-Place PLM Update request after complete restore
1.10  sk   05/07/2024 Added declaration for get ipi instance function
      ma   09/23/2024 Added support for PSM to PLM IPI event handler
1.11  gam  01/07/2025 Created dummy IPI APIs in case of no IPI instance to
                      fix plm build issue with XilSEM.
      pre  03/02/2025 Modified IPIdispatchhandler for external linkage</pre><pre></pre><dl class="section note"><dt>Note</dt><dd></dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac8d5c430e81040176ad4ac64ac821fc9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__server__apis.html#gac8d5c430e81040176ad4ac64ac821fc9">XPlmi_ValidateIpiCmd</a> (XPlmi_Cmd *Cmd, u32 SrcIndex)</td></tr>
<tr class="memdesc:gac8d5c430e81040176ad4ac64ac821fc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks whether the Cmd passed is supported via IPI mechanism or not.  <a href="group__xilplmi__server__apis.html#gac8d5c430e81040176ad4ac64ac821fc9">More...</a><br/></td></tr>
<tr class="separator:gac8d5c430e81040176ad4ac64ac821fc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19c06d7c3fa745638e0bf0bce7d57ce7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__server__apis.html#ga19c06d7c3fa745638e0bf0bce7d57ce7">XPlmi_IpiWrite</a> (u32 DestCpuMask, const u32 *MsgPtr, u32 MsgLen, u8 Type)</td></tr>
<tr class="memdesc:ga19c06d7c3fa745638e0bf0bce7d57ce7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function writes an IPI message or a response to destination CPU.  <a href="group__xilplmi__server__apis.html#ga19c06d7c3fa745638e0bf0bce7d57ce7">More...</a><br/></td></tr>
<tr class="separator:ga19c06d7c3fa745638e0bf0bce7d57ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1c8efe2f8e8410352de5ad07befa57e9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__server__apis.html#ga1c8efe2f8e8410352de5ad07befa57e9">XPlmi_IpiRead</a> (u32 SrcCpuMask, u32 *MsgPtr, u32 MsgLen, u8 Type)</td></tr>
<tr class="memdesc:ga1c8efe2f8e8410352de5ad07befa57e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads an IPI message or response from source CPU.  <a href="group__xilplmi__server__apis.html#ga1c8efe2f8e8410352de5ad07befa57e9">More...</a><br/></td></tr>
<tr class="separator:ga1c8efe2f8e8410352de5ad07befa57e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga98cd46d1d0f1e300798b78d9c9207862"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__server__apis.html#ga98cd46d1d0f1e300798b78d9c9207862">XPlmi_IpiTrigger</a> (u32 DestCpuMask)</td></tr>
<tr class="memdesc:ga98cd46d1d0f1e300798b78d9c9207862"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function triggers the IPI interrupt to destination CPU.  <a href="group__xilplmi__server__apis.html#ga98cd46d1d0f1e300798b78d9c9207862">More...</a><br/></td></tr>
<tr class="separator:ga98cd46d1d0f1e300798b78d9c9207862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c5a563dcf8b5c6e0e9d01328f0ad716"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__server__apis.html#ga9c5a563dcf8b5c6e0e9d01328f0ad716">XPlmi_IpiPollForAck</a> (u32 DestCpuMask, u32 TimeOutCount)</td></tr>
<tr class="memdesc:ga9c5a563dcf8b5c6e0e9d01328f0ad716"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function polls for IPI acknowledgment from destination CPU.  <a href="group__xilplmi__server__apis.html#ga9c5a563dcf8b5c6e0e9d01328f0ad716">More...</a><br/></td></tr>
<tr class="separator:ga9c5a563dcf8b5c6e0e9d01328f0ad716"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
